Catch Docusaurus build issues #498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
TODO: We need to make sure we resolve the linter errors before merging this. |
|
I am going to put this in draft and add some more functionality to prevent build issues in the new docs engine |
|
Sounds good. ping when ready |
ptgott
force-pushed
the
paul.gottschling/2024-10-08-params
branch
from
5d02681
to
f00eaeb
Compare
Break the docs build on states that are acceptable for the current
NextJS-based docs engine but cause Docusaurus builds to fail:
- **Unresolved partial parameters:** Edit the `remark-includes` linter
to ensure that all parameters declared within a partial (using `{{
param }}` syntax) are either (a) assigned by the user or (b) given a
default value. Otherwise, when we move to the new docs engine, builds
will fail on unresolved parameters.
- **Add more config checks:** Throw an exception for duplicate redirects
and redirects where the `source` points to an existing file. With the
current logic, this check takes place with every page build. While
this is not ideal, and leads to noisy error output, we should be
migrating soon and will not need to deal with this for long.
ptgott
force-pushed
the
paul.gottschling/2024-10-08-params
branch
from
fb59889
to
b25c045
Compare
ptgott
changed the title
|
@avatus Hopefully, merging gravitational/teleport#47471 will get the checks introduced by this PR to pass, so the Vercel workflow will finish! |
avatus
approved these changes
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Break the docs build on states that are acceptable for the current
NextJS-based docs engine but cause Docusaurus builds to fail:
Unresolved partial parameters: Edit the
remark-includeslinterto ensure that all parameters declared within a partial (using
{{ param }}syntax) are either (a) assigned by the user or (b) given adefault value. Otherwise, when we move to the new docs engine, builds
will fail on unresolved parameters.
Add more config checks: Throw an exception for duplicate redirects
and redirects where the
sourcepoints to an existing file. With thecurrent logic, this check takes place with every page build. While
this is not ideal, and leads to noisy error output, we should be
migrating soon and will not need to deal with this for long.